Skip to content

docs: README opening in the house shape - #3

Merged
ricardofrantz merged 5 commits into
mainfrom
docs/readme-opening
Nov 16, 2026
Merged

ricardofrantz merged 5 commits into
mainfrom
docs/readme-opening

Conversation

@ricardofrantz

@ricardofrantz ricardofrantz commented Nov 13, 2026 •

Copy link
Copy Markdown
Member
  • Removes the title heading; the README now opens on the name-first line.
  • No LICENSE file, so no licence badge; no banner image or CI workflow.

Proof

Checked on 2026-11-16 at head 64a75a4 of docs/readme-opening.

  • README opened with gh api repos/BoringQuantSystems/boringquantsystems.github.io/contents/README.md?ref=docs/readme-opening: HTTP 200, 1173 bytes, blob ebcd011.
  • First README line on the branch: ![boringquantsystems.github.io banner](https://raw.githubusercontent.com/BoringQuantSystems/boringquantsystems.github.io/main/assets/readme-banner-v3.jpg)
  • Banner file in the branch tree (git ls-tree equivalent):
100644 blob 028694d9adfa21fc359aa8e21cadeb6585eb71ec	assets/readme-banner-v3.jpg
  • Files changed against main: LICENSE, README.md, assets/readme-banner-v3.jpg.

The description above predates later commits on this branch (for example the banner or the LICENSE file); this section describes the current branch.

View guided diff

Summary by CodeRabbit

  • Documentation
    • Updated the README opening to describe the BoringQuantSystems website and format its web address as code.

…, no title heading

Co-authored-by: Ricardo Frantz <4220623+ricardofrantz@users.noreply.github.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

View guided diff | Re-trigger cubic

@coderabbitai

coderabbitai Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README opening now describes boringquantsystems.github.io as the BoringQuantSystems website and formats the domain as inline code.

Changes: README Opening Update

Layer / File(s) Summary
README opening
README.md
The opening combines the site name and description in one sentence. The domain uses inline code formatting.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: Minimal · up to a779b

This PR changes only the README opening, so it has no effect on runtime behavior and is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the docs change to the README opening. The raw summary says the README opening now formats boringquantsystems.github.io as inline code, describes it as the BoringQuantSystems website, …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check

Explanation

The title names the docs change to the README opening. The raw summary says the README opening now formats boringquantsystems.github.io as inline code, describes it as the BoringQuantSystems website, and merges the former heading into the opening sentence. The title's 'README opening in the house shape' is specific but leans on a term ('house shape') that the changeset does not explain. The PR objectives do clarify that the title heading is removed so the README opens with a name-first line, so the title is related to the main change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
Simplify code

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Central YAML; Path: .coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 5d7e2345-80c2-4754-85fe-30de8742d104
Commits

Reviewing files that changed from the base of the PR and between c055fa9 and a779be1.

Files selected for processing: 1

  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Co-authored-by: Ricardo Frantz <4220623+ricardofrantz@users.noreply.github.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 2 files (changes from recent commits).

Reply with feedback, questions, or to request a fix.

View guided diff | Re-trigger cubic

Comment thread LICENSE Resolved
jac-made Bot and others added 2 commits November 15, 2026 21:18
Co-authored-by: Ricardo Frantz <4220623+ricardofrantz@users.noreply.github.com>
…cal repos, horizontal for quantum)

Co-authored-by: Ricardo Frantz <4220623+ricardofrantz@users.noreply.github.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 2 files (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

View guided diff | Re-trigger cubic

Comment thread README.md Resolved
Co-authored-by: Ricardo Frantz <4220623+ricardofrantz@users.noreply.github.com>
@ricardofrantz
ricardofrantz merged commit 600b990 into main Nov 16, 2026
5 checks passed
@ricardofrantz
ricardofrantz deleted the docs/readme-opening branch November 16, 2026 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant